Computer Vision Client (preview:3.0)

2025/10/21 • 2 deleted methods

Read (removed)
Description :  Use this interface to get the result of a Read operation, employing the state-of-the-art Optical Character Recognition (OCR) algorithms optimized for text-heavy documents. When you use the Read interface, the response contains a field called 'Operation-Location'. The 'Operation-Location' field contains the URL that you must use for your 'GetReadResult' operation to access OCR results.​
Reference :  Link ¶

⚼ Request

POST:  /read/analyze
{
language:
{
Description: The BCP-47 language code of the text to be detected in the image. In future versions, when language parameter is not passed, language detection will be used to determine the language. However, in the current version, missing language parameter will cause English to be used. To ensure that your document is always parsed in English without the use of language detection in the future, pass “en” in the language parameter ,
Required: False ,
}
string ,
ImageUrl:
{
Description: A JSON document with a URL pointing to the image that is to be analyzed. ,
Required: True ,
}
{
url:
{
Description: Publicly reachable URL of an image. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (202)

{
operation-location:
{
Description: URL to query for status of the operation. The operation ID will expire in 48 hours. ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Enum:
{
InvalidImageFormat: No description available. ,
UnsupportedMediaType: No description available. ,
InvalidImageUrl: No description available. ,
NotSupportedFeature: No description available. ,
NotSupportedImage: No description available. ,
Timeout: No description available. ,
InternalServerError: No description available. ,
InvalidImageSize: No description available. ,
BadArgument: No description available. ,
DetectFaceError: No description available. ,
NotSupportedLanguage: No description available. ,
InvalidThumbnailSize: No description available. ,
InvalidDetails: No description available. ,
InvalidModel: No description available. ,
CancelledRequest: No description available. ,
NotSupportedVisualFeature: No description available. ,
FailedToProcess: No description available. ,
Unspecified: No description available. ,
StorageException: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A message explaining the error reported by the service. ,
Required: True ,
}
string ,
requestId:
{
Description: A unique request identifier. ,
Required: False ,
}
string ,
}
GetReadResult (removed)
Description :  This interface is used for getting OCR results of Read operation. The URL to this interface should be retrieved from 'Operation-Location' field returned from Read interface.
Reference :  Link ¶

⚼ Request

GET:  /read/analyzeResults/{operationId}
{
operationId:
{
Description: Id of read operation returned in the response of the 'Read' interface. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
status:
{
Description: Status of the read operation. ,
Enum:
{
notStarted: No description available. ,
running: No description available. ,
failed: No description available. ,
succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
createdDateTime:
{
Description: Get UTC date time the batch operation was submitted. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedDateTime:
{
Description: Get last updated UTC date time of this batch operation. ,
Format: date-time ,
Required: False ,
}
string ,
analyzeResult:
{
Description: Analyze batch operation result. ,
Required: False ,
}
{
version:
{
Description: Version of schema used for this result. ,
Required: True ,
}
string ,
readResults:
{
Description: Text extracted from the input. ,
Required: True ,
}
[
{
page:
{
Description: The 1-based page number of the recognition result. ,
Required: True ,
}
integer ,
language:
{
Description: The BCP-47 language code of the recognized text page. ,
Required: False ,
}
string ,
angle:
{
Description: The orientation of the image in degrees in the clockwise direction. Range between [-180, 180). ,
Required: True ,
}
number ,
width:
{
Description: The width of the image in pixels or the PDF in inches. ,
Required: True ,
}
number ,
height:
{
Description: The height of the image in pixels or the PDF in inches. ,
Required: True ,
}
number ,
unit:
{
Description: The unit used in the Width, Height and BoundingBox. For images, the unit is 'pixel'. For PDF, the unit is 'inch'. ,
Enum:
{
pixel: No description available. ,
inch: No description available. ,
}
,
Required: True ,
}
enum ,
lines:
{
Description: A list of recognized text lines. ,
Required: True ,
}
[
{
language:
{
Description: The BCP-47 language code of the recognized text line. Only provided where the language of the line differs from the page's. ,
Required: False ,
}
string ,
boundingBox:
{
Description: Bounding box of a recognized line. ,
Required: True ,
}
[
number ,
]
,
text:
{
Description: The text content of the line. ,
Required: True ,
}
string ,
words:
{
Description: List of words in the text line. ,
Required: True ,
}
[
{
boundingBox:
{
Description: Bounding box of a recognized word. ,
Required: True ,
}
[
number ,
]
,
text:
{
Description: The text content of the word. ,
Required: True ,
}
string ,
confidence:
{
Description: Qualitative confidence measure. ,
Format: float ,
Required: True ,
}
number ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Enum:
{
InvalidImageFormat: No description available. ,
UnsupportedMediaType: No description available. ,
InvalidImageUrl: No description available. ,
NotSupportedFeature: No description available. ,
NotSupportedImage: No description available. ,
Timeout: No description available. ,
InternalServerError: No description available. ,
InvalidImageSize: No description available. ,
BadArgument: No description available. ,
DetectFaceError: No description available. ,
NotSupportedLanguage: No description available. ,
InvalidThumbnailSize: No description available. ,
InvalidDetails: No description available. ,
InvalidModel: No description available. ,
CancelledRequest: No description available. ,
NotSupportedVisualFeature: No description available. ,
FailedToProcess: No description available. ,
Unspecified: No description available. ,
StorageException: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A message explaining the error reported by the service. ,
Required: True ,
}
string ,
requestId:
{
Description: A unique request identifier. ,
Required: False ,
}
string ,
}